<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
    <title>ShellCheck: Buildkite – </title>
    <link rel="stylesheet" href="css/bootstrap.min.css" />
  </head>
  <body style="margin-left: auto; margin-right: auto; max-width: 800px">
    <h1>Buildkite – ShellCheck Wiki</h1>
    <a href="https://github.com/koalaman/shellcheck/wiki/Buildkite">See this page on GitHub</a>
    <p style="display: none"><a href="index.html">Sitemap</a></p>
    <hr />
    <p>Buildkite provides <a
href="https://github.com/buildkite-plugins/shellcheck-buildkite-plugin">a
plugin dedicated to run <code>shellcheck</code></a>.</p>
<p>Simply add this step to your Buildkite pipeline
(<code>.buildkite/pipeline.yml</code>) to use it:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb1-1"><a href="Buildkite.html#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">steps</span><span class="kw">:</span></span>
<span id="cb1-2"><a href="Buildkite.html#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="kw">-</span><span class="at"> </span><span class="fu">label</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;:shell: Shellcheck&quot;</span></span>
<span id="cb1-3"><a href="Buildkite.html#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">plugins</span><span class="kw">:</span></span>
<span id="cb1-4"><a href="Buildkite.html#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="at">      shellcheck</span><span class="co">#v1.1.2:</span></span>
<span id="cb1-5"><a href="Buildkite.html#cb1-5" aria-hidden="true" tabindex="-1"></a><span class="co">        # List the files you want to lint</span></span>
<span id="cb1-6"><a href="Buildkite.html#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="at">        </span><span class="fu">files</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">&quot;**/*.sh&quot;</span><span class="kw">]</span></span>
<span id="cb1-7"><a href="Buildkite.html#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="co">        # additional options to pass to shellcheck (optional)</span></span>
<span id="cb1-8"><a href="Buildkite.html#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="at">        </span><span class="fu">options</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">&quot;-x&quot;</span><span class="kw">,</span><span class="at"> </span><span class="st">&quot;-P&quot;</span><span class="kw">,</span><span class="at"> </span><span class="st">&quot;SCRIPTDIR&quot;</span><span class="kw">]</span></span></code></pre></div>
    <hr />
    <p style='font-size: 80%'><a href="../index.html">ShellCheck</a> is a static analysis tool for shell scripts. This page is part of its documentation.</p>
  </body>
</html>


